DescribePropertySoftwareDetail

Description

call the DescribePropertySoftwareDetail interface to get the details of a software in the software list.

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertySoftwareDetail

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Path	BODY	string	No	/etc/test	software installation path.
SoftwareVersion	BODY	string	No	11	software version information.
Uuid	BODY	string	No	50d213b4-3a35-427a-b8a5-***	the unique ID of the asset instance to which the software belongs.
PageSize	BODY	integer	No	5	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api
Name	BODY	string	No	tes***	software name.
Remark	BODY	string	No	1.2.3.4	server name or IP.

Return data

Name	Type	Sample value	Description
Path	string	/etc/test	installation directory information for software assets.
Propertys	array	No sample value for this parameter.	software information.
PageSize	integer	2	The maximum number of pieces of data per page displayed during a paged query.
RequestId	string	9C5AE850-7140-4DE6-B892-055EB0D9F28A	request ID of the result.
InstallTime	string	2017-09-07 10:54:49	returned software installation time.
InstanceId	string	i-uf***	asset instance ID.
Ip	string	1.2.3.1	assets correspond to public IP addresses.
Count	integer	2	the number of data on the current page displayed during paging query.
IntranetIp	string	1.2.3.2	the asset corresponds to the private IP address.
Name	string	aaa_base	software name.
InstanceName	string	test	asset name.
PageInfo		No sample value for this parameter.	page display information.
TotalCount	integer	23	the total number of data.
Uuid	string	4ef1115b-e423-4b4b-b930-***	returned software version information.
InternetIp	string	1.2.3.1	assets correspond to public IP addresses.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
Version	string	11	the version information corresponding to the software asset.
Create	long	2019-06-24	the latest data collection time.
CreateTimestamp	long	1565539587000	the latest collection timestamp of the data.

Example

Successful Response example

{
 "Path":"/etc/test",
 "Propertys":"",
 "PageSize":"2",
 "RequestId":"9C5AE850-7140-4DE6-B892-055EB0D9F28A",
 "InstallTime":"2017-09-07 10:54:49",
 "InstanceId":"i-uf***",
 "Ip":"1.2.3.1",
 "Count":"2",
 "IntranetIp":"1.2.3.2",
 "Name":"aaa_base",
 "InstanceName":"test",
 "PageInfo":"",
 "TotalCount":"23",
 "Uuid":"4ef1115b-e423-4b4b-b930-***",
 "InternetIp":"1.2.3.1",
 "CurrentPage":"1",
 "Version":"11",
 "Create":"2019-06-24",
 "CreateTimestamp":"1565539587000"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribePropertySoftwareItem

sidebar_position: 3

DescribePropertySoftwareItem

Description

call DescribePropertySoftwareItem interface to obtain all software list information. .

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertySoftwareItem

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	10	specifies the number of data items displayed on each page of the list.
CurrentPage	BODY	integer	No	1	specifies the current page number of the returned result.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api
ForceFlush	BODY	boolean	No	true	whether to force refresh the data to be queried.
Name	BODY	string	No	test	specify the name of the software to be queried.

Return data

Name	Type	Sample value	Description
PageInfo	struct	No sample value for this parameter.	the page that returns the result displays information.
TotalCount	integer	5037	returns the total number of data.
RequestId	string	3A85CFCF-05C8-451A-9E41-C0D5E96BA407	request ID.
PageSize	integer	2	The number of data pieces per page in the returned result.
CurrentPage	integer	1	returns the current page number displayed in the result.
Count	integer	2	the number of data displayed on the current page of the returned result.
PropertyItems	array	No sample value for this parameter.	returned software list.
Name	string	aaa_base	the name of the returned software asset.

Example

Successful Response example

{
 "PageInfo":"",
 "TotalCount":"5037",
 "RequestId":"3A85CFCF-05C8-451A-9E41-C0D5E96BA407",
 "PageSize":"2",
 "CurrentPage":"1",
 "Count":"2",
 "PropertyItems":"",
 "Name":"aaa_base"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribePropertyUsageNewest

sidebar_position: 3

DescribePropertyUsageNewest

Description

call the DescribePropertyUsageNewest to query the newly created list of 5 account information.

Request Method

POST

Request Path

/apsara/route/Sas/DescribePropertyUsageNewest

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Type	BODY	string	No	user	account type. Value: user: system:
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
NewestStatisticItems	array	No sample value for this parameter.	account information.
Type	string	user	the account created on this server. fixed value: user, which indicates the user account.
RequestId	string	27C78A20-0833-4519-B392-F7963CCFC6AC	the request ID returned by querying the newly created 5 account information.
Create	long	1566178646000	account creation time.
ItemCount	integer	5	Number of lists.
Name	string	root	account name.

Example

Successful Response example

{
 "NewestStatisticItems":"",
 "Type":"user",
 "RequestId":"27C78A20-0833-4519-B392-F7963CCFC6AC",
 "Create":"1566178646000",
 "ItemCount":"5",
 "Name":"root"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}